Minor updates to documentation #189
Conversation
jonnew
commented
Aug 2, 2024
jonnew
commented
- Clarification and typo fixes
- Clarification and typo fixes
| @@ -6,19 +6,26 @@ namespace OpenEphys.Onix1 | |||
| { | |||
| /// <summary> | |||
| /// Provides an abstract base class for configuration operators responsible for | |||
| /// registering all devices in an ONI device aggregate in the context device table. | |||
| /// registering logical groups of <see cref="oni.Device"/>s. | |||
There was a problem hiding this comment.
This somehow seems now less clear, since it makes it seem the operator is registering the group rather than each individual device. Maybe we shouldn't talk about "device table" since that is a hardware specific concept, but mentioning that there is a context "device manager" might be important so people understand why sometimes the drop down shows devices and sometimes not.
There was a problem hiding this comment.
Really, as far as I see, we are both wrong.
- Device table is hardware-agnostic, its required by the ONI API regardless of hardware
- This class does not configure aggregates of oni.Devices (nullifying impact of last bullet), but OpenEphys.Onix1's concept of device, which is much looser (e.g. any dev using passthrough), is really what this class is used to configure. We don't really make it clear that this library kinda cares about devices, but will happily abstract a device if it makes things work better.
I m going to remove references to oni.Devices because its just not correct. I agree with Device manager comment ill try to add some text.
| /// These multi-device aggregates are the most common starting point for configuration | ||
| /// of an ONI system, and the <see cref="MultiDeviceFactory"/> provides a modular abstraction | ||
| /// for flexible assembly and sequencing of multiple such aggregates. | ||
| /// This class allows configuration of logical device groups of <see cref="oni.Device"/>s across ONI-defined |
There was a problem hiding this comment.
| /// This class allows configuration of logical device groups of <see cref="oni.Device"/>s across ONI-defined | |
| /// This class allows configuration of logical groups of <see cref="oni.Device"/>s across ONI-defined |
| @@ -34,10 +41,10 @@ internal MultiDeviceFactory() | |||
| } | |||
|
|
|||
| /// <summary> | |||
| /// Gets or sets a unique hub device name. | |||
| /// Gets or sets a unique device group name. | |||
There was a problem hiding this comment.
Could be useful to clarify here that this name is used as a prefix for individual device names in the group.
- There was lingering discussion after merge into main occured, this attempts to address that
Resolve issues in discussion of #189
